Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve descriptions in Network to align with Swagger guidelines #6350

Merged
merged 2 commits into from
Jun 24, 2019
Merged

Improve descriptions in Network to align with Swagger guidelines #6350

merged 2 commits into from
Jun 24, 2019

Conversation

anton-evseev
Copy link
Contributor

Latest improvements:

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

Contribution checklist:

  • I have reviewed the documentation for the workflow.
  • Validation tools were run on swagger spec(s) and have all been fixed in this PR.
  • The OpenAPI Hub was used for checking validation status and next steps.

ARM API Review Checklist

  • Service team MUST add the "WaitForARMFeedback" label if the management plane API changes fall into one of the below categories.
  • adding/removing APIs.
  • adding/removing properties.
  • adding/removing API-version.
  • adding a new service in Azure.

Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs.

  • If you are blocked on ARM review and want to get the PR merged urgently, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.
    Please follow the link to find more details on API review process.

@AutorestCI
Copy link

AutorestCI commented Jun 14, 2019 •
edited
Loading

Automation for azure-sdk-for-java

Nothing to generate for azure-sdk-for-java

@AutorestCI
Copy link

AutorestCI commented Jun 14, 2019 •
edited
Loading

Automation for azure-sdk-for-python

Encountered a Subprocess error: (azure-sdk-for-python)

Command: ['/usr/local/bin/autorest', '/tmp/tmp4_7ynrel/rest/specification/network/resource-manager/readme.md', '--keep-version-file', '--multiapi', '--no-async', '--python', '--python-mode=update', '--python-sdks-folder=/tmp/tmp4_7ynrel/sdk/sdk', '--use=@microsoft.azure/autorest.python@4.0.70', '--version=preview']
Finished with return code -6
and output:

AutoRest code generation utility [version: 2.0.4283; node: v10.15.3]
(C) 2018 Microsoft Corporation.
https://aka.ms/autorest
   Loading AutoRest core      '/root/.autorest/@microsoft.azure_autorest-core@2.0.4384/node_modules/@microsoft.azure/autorest-core/dist' (2.0.4384)
   Loading AutoRest extension '@microsoft.azure/autorest.python' (4.0.70->4.0.70)
   Loading AutoRest extension '@microsoft.azure/autorest.modeler' (2.3.44->2.3.44)
Processing batch task - {"tag":"package-2019-04"} .

<--- Last few GCs --->

[26774:0x3a8fcc0]    73850 ms: Mark-sweep 1379.8 (1425.0) -> 1379.4 (1425.5) MB, 1018.7 / 0.0 ms  (average mu = 0.104, current mu = 0.003) allocation failure scavenge might not succeed
[26774:0x3a8fcc0]    75492 ms: Mark-sweep 1380.3 (1425.5) -> 1379.8 (1426.0) MB, 1638.6 / 0.0 ms  (average mu = 0.048, current mu = 0.002) allocation failure scavenge might not succeed


<--- JS stacktrace --->

==== JS stack trace =========================================

Security context: 0x08908961e6e9 <JSObject>
    0: builtin exit frame: stringify(this=0x089089611a21 <Object map = 0x5d0d34042a9>,0x1fb3a70826f1 <undefined>,0x1fb3a70826f1 <undefined>,0x0d8102b4af39 <JSArray[6]>,0x089089611a21 <Object map = 0x5d0d34042a9>)

    1: arguments adaptor frame: 1->3
    2: IdentitySourceMapping [0x320a240a3009] [/root/.autorest/@microsoft.azure_autorest-core@2.0.4384/node_modules/@microsoft.azure/autorest-core/...

FATAL ERROR: Ineffective mark-compacts near heap limit Allocation failed - JavaScript heap out of memory
 1: 0x8dc510 node::Abort() [node]
 2: 0x8dc55c  [node]
 3: 0xad9b5e v8::Utils::ReportOOMFailure(v8::internal::Isolate*, char const*, bool) [node]
 4: 0xad9d94 v8::internal::V8::FatalProcessOutOfMemory(v8::internal::Isolate*, char const*, bool) [node]
 5: 0xec7bf2  [node]
 6: 0xec7cf8 v8::internal::Heap::CheckIneffectiveMarkCompact(unsigned long, double) [node]
 7: 0xed3dd2 v8::internal::Heap::PerformGarbageCollection(v8::internal::GarbageCollector, v8::GCCallbackFlags) [node]
 8: 0xed4704 v8::internal::Heap::CollectGarbage(v8::internal::AllocationSpace, v8::internal::GarbageCollectionReason, v8::GCCallbackFlags) [node]
 9: 0xed7371 v8::internal::Heap::AllocateRawWithRetryOrFail(int, v8::internal::AllocationSpace, v8::internal::AllocationAlignment) [node]
10: 0xe9f5a6  [node]
11: 0xea26d2 v8::internal::Factory::NewConsString(v8::internal::Handle<v8::internal::String>, v8::internal::Handle<v8::internal::String>, int, bool) [node]
12: 0xea93e8 v8::internal::Factory::NewConsString(v8::internal::Handle<v8::internal::String>, v8::internal::Handle<v8::internal::String>) [node]
13: 0x11d6bd0 v8::internal::IncrementalStringBuilder::Finish() [node]
14: 0xfa1779 v8::internal::JsonStringifier::Stringify(v8::internal::Handle<v8::internal::Object>, v8::internal::Handle<v8::internal::Object>, v8::internal::Handle<v8::internal::Object>) [node]
15: 0xba9121 v8::internal::Builtin_JsonStringify(int, v8::internal::Object**, v8::internal::Isolate*) [node]
16: 0x34184a5bf7d

@AutorestCI
Copy link

AutorestCI commented Jun 14, 2019 •
edited
Loading

Automation for azure-sdk-for-go

Encountered a Subprocess error: (azure-sdk-for-go)

Command: ['/usr/local/bin/autorest', '/tmp/tmpkx3yzl4c/rest/specification/network/resource-manager/readme.md', '--go', '--go-sdk-folder=/tmp/tmpkx3yzl4c/src/github.com/Azure/azure-sdk-for-go', '--multiapi', '--preview-chk', '--use=@microsoft.azure/autorest.go@~2.1.133', '--use-onever', '--verbose']
Finished with return code -6
and output:

AutoRest code generation utility [version: 2.0.4283; node: v8.12.0]
(C) 2018 Microsoft Corporation.
https://aka.ms/autorest
   Loading AutoRest core      '/root/.autorest/@microsoft.azure_autorest-core@2.0.4302/node_modules/@microsoft.azure/autorest-core/dist' (2.0.4302)
   Including configuration file 'file:///tmp/tmpkx3yzl4c/rest/specification/network/resource-manager/readme.go.md'
   Loading AutoRest extension '@microsoft.azure/autorest.go' (~2.1.133->2.1.133)
   Loading AutoRest extension '@microsoft.azure/autorest.modeler' (2.3.38->2.3.38)
Processing batch task - {"tag":"package-2019-02"} .
   Including configuration file 'file:///tmp/tmpkx3yzl4c/rest/specification/network/resource-manager/readme.go.md'

<--- Last few GCs --->

[29761:0x2e028c0]   122936 ms: Mark-sweep 1387.1 (1475.4) -> 1387.0 (1476.4) MB, 1580.2 / 0.0 ms  allocation failure GC in old space requested
[29761:0x2e028c0]   124560 ms: Mark-sweep 1387.0 (1476.4) -> 1387.0 (1440.4) MB, 1623.6 / 0.0 ms  last resort GC in old space requested
[29761:0x2e028c0]   126195 ms: Mark-sweep 1387.0 (1440.4) -> 1387.0 (1437.4) MB, 1634.0 / 0.0 ms  last resort GC in old space requested


<--- JS stacktrace --->

==== JS stack trace =========================================

Security context: 0x3fe576ba5879 <JSObject>
    1: set [native weak-collection.js:~27] [pc=0x3480b4171869](this=0x22534a243b29 <JSWeakMap>,key=0x13d28a7d6bb9 <Object map = 0x38d993220131>,value=0x14d5483bc5a1 <String[6]: String>)
    2: /* anonymous */(aka /* anonymous */) [/root/.autorest/@microsoft.azure_autorest-core@2.0.4302/node_modules/@microsoft.azure/autorest-core/dist/lib/ref/yaml.js:~101] [pc=0x3480b41609f9](this=0x287abbe822d1 ...

FATAL ERROR: CALL_AND_RETRY_LAST Allocation failed - JavaScript heap out of memory
 1: node::Abort() [node]
 2: 0x8cbf4c [node]
 3: v8::Utils::ReportOOMFailure(char const*, bool) [node]
 4: v8::internal::V8::FatalProcessOutOfMemory(char const*, bool) [node]
 5: v8::internal::Factory::NewFixedArray(int, v8::internal::PretenureFlag) [node]
 6: v8::internal::HashTable<v8::internal::ObjectHashTable, v8::internal::ObjectHashTableShape>::NewInternal(v8::internal::Isolate*, int, v8::internal::PretenureFlag) [node]
 7: v8::internal::HashTable<v8::internal::ObjectHashTable, v8::internal::ObjectHashTableShape>::New(v8::internal::Isolate*, int, v8::internal::PretenureFlag, v8::internal::MinimumCapacity) [node]
 8: v8::internal::HashTable<v8::internal::ObjectHashTable, v8::internal::ObjectHashTableShape>::EnsureCapacity(v8::internal::Handle<v8::internal::ObjectHashTable>, int, v8::internal::PretenureFlag) [node]
 9: v8::internal::ObjectHashTable::Put(v8::internal::Handle<v8::internal::ObjectHashTable>, v8::internal::Handle<v8::internal::Object>, v8::internal::Handle<v8::internal::Object>, int) [node]
10: v8::internal::JSWeakCollection::Set(v8::internal::Handle<v8::internal::JSWeakCollection>, v8::internal::Handle<v8::internal::Object>, v8::internal::Handle<v8::internal::Object>, int) [node]
11: v8::internal::Runtime_WeakCollectionSet(int, v8::internal::Object**, v8::internal::Isolate*) [node]
12: 0x3480b40042fd

@AutorestCI
Copy link

AutorestCI commented Jun 14, 2019 •
edited
Loading

Automation for azure-sdk-for-js

Encountered a Subprocess error: (azure-sdk-for-js)

Command: ['/usr/local/bin/autorest', '/tmp/tmpeyj6ws19/rest/specification/network/resource-manager/readme.md', '--license-header=MICROSOFT_MIT_NO_VERSION', '--typescript', '--typescript-sdks-folder=/tmp/tmpeyj6ws19/azure-sdk-for-js', '--use=@microsoft.azure/autorest.typescript@4.0.0']
Finished with return code -6
and output:

AutoRest code generation utility [version: 2.0.4283; node: v8.12.0]
(C) 2018 Microsoft Corporation.
https://aka.ms/autorest
   Loading AutoRest core      '/root/.autorest/@microsoft.azure_autorest-core@2.0.4299/node_modules/@microsoft.azure/autorest-core/dist' (2.0.4299)
   Loading AutoRest extension '@microsoft.azure/autorest.typescript' (4.0.0->4.0.0)
   Loading AutoRest extension '@microsoft.azure/autorest.modeler' (2.3.51->2.3.51)

<--- Last few GCs --->

[10691:0x2bfb860]   144211 ms: Mark-sweep 1396.3 (1481.1) -> 1396.3 (1481.6) MB, 1807.4 / 0.0 ms  allocation failure GC in old space requested
[10691:0x2bfb860]   145888 ms: Mark-sweep 1396.3 (1481.6) -> 1396.2 (1444.6) MB, 1676.5 / 0.0 ms  last resort GC in old space requested
[10691:0x2bfb860]   147461 ms: Mark-sweep 1396.2 (1444.6) -> 1396.2 (1442.1) MB, 1572.3 / 0.0 ms  last resort GC in old space requested


<--- JS stacktrace --->

==== JS stack trace =========================================

Security context: 0x353b5f0a5879 <JSObject>
    1: readLineBreak(aka readLineBreak) [/node_modules/yaml-ast-parser/dist/src/loader.js:~300] [pc=0x37d9deba0e42](this=0x2375600022d1 <undefined>,state=0x31b1ad2468d1 <State map = 0x1e1c384b7d61>)
    2: readFlowCollection(aka readFlowCollection) [/node_modules/yaml-ast-parser/dist/src/loader.js:~596] [pc=0x37d9deb97f90](this=0x2375600022d1 <undefined>,state=0x31b1ad2468d1 <State map = 0x1e1c3...

FATAL ERROR: CALL_AND_RETRY_LAST Allocation failed - JavaScript heap out of memory
 1: node::Abort() [node]
 2: 0x8cbf4c [node]
 3: v8::Utils::ReportOOMFailure(char const*, bool) [node]
 4: v8::internal::V8::FatalProcessOutOfMemory(char const*, bool) [node]
 5: v8::internal::Factory::NewUninitializedFixedArray(int) [node]
 6: 0xd7fc13 [node]
 7: v8::internal::Runtime_GrowArrayElements(int, v8::internal::Object**, v8::internal::Isolate*) [node]
 8: 0x37d9de7842fd

@AutorestCI
Copy link

AutorestCI commented Jun 14, 2019 •
edited
Loading

Automation for azure-sdk-for-ruby

Nothing to generate for azure-sdk-for-ruby

@azuresdkci
Copy link
Contributor

Can one of the admins verify this patch?

@anton-evseev
Copy link
Contributor Author

@tjprescott could you please merge this PR?

@tjprescott tjprescott merged commit c22ce34 into Azure:network-may-release Jun 24, 2019
@anton-evseev anton-evseev deleted the improve-descriptions branch June 26, 2019 06:35
sergey-shandar pushed a commit that referenced this pull request Jul 16, 2019
@anton-evseev @sergey-shandar
Merge Network release branch into master (#6632)
737110f 
* Adds base for updating Microsoft.Network from version stable/2019-04-01 to version 2019-06-01

* Updates readme

* Updates API version in new specs and examples

* Add PrivateIPAddressVersion in LoadBalancerFrontendIpConfiguration pr… (#6164)

* Add PrivateIPAddressVersion in LoadBalancerFrontendIpConfiguration properties.

* Fixed LB examples

* Fix examples in 2019-06-01

* Remove API version number in privateIPAddressVersion description.

* Add privateIPAddressVersion in LoadBalancer examples.

* Add privateIPAddressVersion in 2019-06-01 API version.

* Update specs to avoid readOnly in the request body (#6228)

* typo: netowork May double word the (#6206)

* Update cipher suites (#6213)

* removing resource group name from PrepareNetworkPoliciesRequest (#6232)

* Add exception for property "Conditon" in Network's webapplicationfirewall.json (#6335)

* Extend long-running ops fixes to new API version; Suppression (#6336)

* Update long-running for new API version

* Add suppression for new API

* Updated examples to have valid bodies for live put (#6349)

* More examples fix after live testing (#6382)

* Improved more examples after live testing

* Fix validations

* Improve descriptions in Network to align with Swagger guidelines (#6350)

* Improve descriptions in Network to align with Swagger guidelines

* Fix for CI

* More examples improvements (#6444)

* Add PATCH to Azure Firewall supported operations (#6486)

* Add PATCH to Azure Firewall supported operations

* Name the parameter how validation expects it

* Patch is not a long running operation, so update the specs accordingly

* PrivateEndpoint & PrivateLinkService APIs update (#6332)

* Add two properties on Subnet for privateIp. Add two new APIs to support privateIp.

Minor modify on readme.md file.

* Fix some issue found by Model Validation.

* Merge all apis relative to private end point / private link service to its json file.

* Fix a typo name from design spec that casue GetAvailablePrivateEndpointType get null property.

* Change AutoApprovedPrivateLinkService structure to fit with NRP side.

* Delete suppress for merged APIs in readme.md.

* 1. Change value to PrivateEndpointConnection when calling put PrivateEndpointConnect.
2. Change opertaion id for opertaions that relative to private endpoint and private link service.

* Minor fix for model validation.

* Revert opertion id changes for AvailablePrivateEndpointType to previous name.

* 1. Change CheckPrivateLinkServiceVisibility API, the input now has a body content that contains a private link service alias string.
2. Change both CheckPrivateLinkServiceVisibility/AutoApprovedPrivateLinkServices API to support for with/without ResourceGroup parameter.

* Improve Network's examples (#6493)

* Removed read-only props from VPNGW example

* Fixed LoadBalancer examples:
* "outboundRules" array isn't returned for "Basic" SKU load balancer
* added example for external LB with outboundRules
* added missing read-only properties

* Replace "regionName" in examples with real location

* Fixed incorrect descriptions in LoadBalancer: child resource doesn't have to have a unique name within resource group, but within a set of similar resource on parent load balancer

* chore: jsonfmt network (#6592)

* Adding VpnSiteLink and VpnSiteLinkConnection properties. (#6528)

* Added VpnSiteLink/VpnSiteLinkConnection operations.

* Sdk changes for vpn site link.

* Fixing error.

* Fixing more comments.

* Fixing json error.

* Fixing json files.

* Fixing comments.

* Fixing more issues.

* Fixing more errors.

* Fixing more error.

* Prettify JSON in VpnConnectionGet.json

* Resolving more comments.

* Fixing typo.

* Adding type in examples of put.

* Removing Child resource type.

* chore: jsonfmt network-may

* Fix incorrect examples
celikcigdem pushed a commit to celikcigdem/azure-rest-api-specs that referenced this pull request Jul 17, 2019
@anton-evseev @celikcigdem
Merge Network release branch into master (Azure#6632)
cd19c2b 
* Adds base for updating Microsoft.Network from version stable/2019-04-01 to version 2019-06-01

* Updates readme

* Updates API version in new specs and examples

* Add PrivateIPAddressVersion in LoadBalancerFrontendIpConfiguration pr… (Azure#6164)

* Add PrivateIPAddressVersion in LoadBalancerFrontendIpConfiguration properties.

* Fixed LB examples

* Fix examples in 2019-06-01

* Remove API version number in privateIPAddressVersion description.

* Add privateIPAddressVersion in LoadBalancer examples.

* Add privateIPAddressVersion in 2019-06-01 API version.

* Update specs to avoid readOnly in the request body (Azure#6228)

* typo: netowork May double word the (Azure#6206)

* Update cipher suites (Azure#6213)

* removing resource group name from PrepareNetworkPoliciesRequest (Azure#6232)

* Add exception for property "Conditon" in Network's webapplicationfirewall.json (Azure#6335)

* Extend long-running ops fixes to new API version; Suppression (Azure#6336)

* Update long-running for new API version

* Add suppression for new API

* Updated examples to have valid bodies for live put (Azure#6349)

* More examples fix after live testing (Azure#6382)

* Improved more examples after live testing

* Fix validations

* Improve descriptions in Network to align with Swagger guidelines (Azure#6350)

* Improve descriptions in Network to align with Swagger guidelines

* Fix for CI

* More examples improvements (Azure#6444)

* Add PATCH to Azure Firewall supported operations (Azure#6486)

* Add PATCH to Azure Firewall supported operations

* Name the parameter how validation expects it

* Patch is not a long running operation, so update the specs accordingly

* PrivateEndpoint & PrivateLinkService APIs update (Azure#6332)

* Add two properties on Subnet for privateIp. Add two new APIs to support privateIp.

Minor modify on readme.md file.

* Fix some issue found by Model Validation.

* Merge all apis relative to private end point / private link service to its json file.

* Fix a typo name from design spec that casue GetAvailablePrivateEndpointType get null property.

* Change AutoApprovedPrivateLinkService structure to fit with NRP side.

* Delete suppress for merged APIs in readme.md.

* 1. Change value to PrivateEndpointConnection when calling put PrivateEndpointConnect.
2. Change opertaion id for opertaions that relative to private endpoint and private link service.

* Minor fix for model validation.

* Revert opertion id changes for AvailablePrivateEndpointType to previous name.

* 1. Change CheckPrivateLinkServiceVisibility API, the input now has a body content that contains a private link service alias string.
2. Change both CheckPrivateLinkServiceVisibility/AutoApprovedPrivateLinkServices API to support for with/without ResourceGroup parameter.

* Improve Network's examples (Azure#6493)

* Removed read-only props from VPNGW example

* Fixed LoadBalancer examples:
* "outboundRules" array isn't returned for "Basic" SKU load balancer
* added example for external LB with outboundRules
* added missing read-only properties

* Replace "regionName" in examples with real location

* Fixed incorrect descriptions in LoadBalancer: child resource doesn't have to have a unique name within resource group, but within a set of similar resource on parent load balancer

* chore: jsonfmt network (Azure#6592)

* Adding VpnSiteLink and VpnSiteLinkConnection properties. (Azure#6528)

* Added VpnSiteLink/VpnSiteLinkConnection operations.

* Sdk changes for vpn site link.

* Fixing error.

* Fixing more comments.

* Fixing json error.

* Fixing json files.

* Fixing comments.

* Fixing more issues.

* Fixing more errors.

* Fixing more error.

* Prettify JSON in VpnConnectionGet.json

* Resolving more comments.

* Fixing typo.

* Adding type in examples of put.

* Removing Child resource type.

* chore: jsonfmt network-may

* Fix incorrect examples
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tjprescott tjprescott tjprescott approved these changes

@MikhailTryakhov MikhailTryakhov Awaiting requested review from MikhailTryakhov

Assignees

@tjprescott tjprescott

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@anton-evseev @AutorestCI @azuresdkci @tjprescott